<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:15 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Ranking (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="Ranking (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Ranking.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/ranking/api/Interpolator.BezierInterpolator.html" title="class in org.gephi.ranking.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/ranking/api/RankingController.html" title="interface in org.gephi.ranking.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/ranking/api/Ranking.html" target="_top">Frames</a></li>
<li><a href="Ranking.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.ranking.api</div>
<h2 title="Interface Ranking" class="title">Interface Ranking&lt;Element&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">Ranking&lt;Element&gt;</span></pre>
<div class="block">Rankings role is to provide numerical values from objects. These values are
 then send to transformer to be converted in visual signs (e.g. color or size).
 <p>
 For instance for nodes, ranking can be the degree of the node or a numerical
 value like an 'age' or 'duration'.
 <p>
 The <code>getElementType()</code> method should return either
 <code>Ranking.NODE_ELEMENT</code> or <code>Ranking.EDGE_ELEMENT</code> to
 define if it works with node or edge elements. This is important because it
 defines which objects the <code>getValue()</code> eventually receives. For nodes,
 it is given a <a href="../../../../org/gephi/graph/api/NodeData.html" title="interface in org.gephi.graph.api"><code>NodeData</code></a> object and for edges a <a href="../../../../org/gephi/graph/api/EdgeData.html" title="interface in org.gephi.graph.api"><code>EdgeData</code></a>.
 <p>
 One can reuse the <code>AbstractRanking</code> class defined in the
 <code>RankingPlugin</code> module.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Mathieu Bastian</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api"><code>Transformer</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#DEGREE_RANKING">DEGREE_RANKING</a></strong></code>
<div class="block">Default in degree ranking's name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#EDGE_ELEMENT">EDGE_ELEMENT</a></strong></code>
<div class="block">Element type for edges.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#INDEGREE_RANKING">INDEGREE_RANKING</a></strong></code>
<div class="block">Default out degree ranking's name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#NODE_ELEMENT">NODE_ELEMENT</a></strong></code>
<div class="block">Element type for nodes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#OUTDEGREE_RANKING">OUTDEGREE_RANKING</a></strong></code>
<div class="block">Default out degree ranking's name</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#getDisplayName()">getDisplayName</a></strong>()</code>
<div class="block">Returns the display name of this ranking.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#getElementType()">getElementType</a></strong>()</code>
<div class="block">Return the type of element this ranking is manipulating.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#getMaximumValue()">getMaximumValue</a></strong>()</code>
<div class="block">Returns the maximum value of this ranking.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#getMinimumValue()">getMinimumValue</a></strong>()</code>
<div class="block">Returns the minimum value of this ranking.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#getName()">getName</a></strong>()</code>
<div class="block">Returns the name of this ranking.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#getValue(Element)">getValue</a></strong>(<a href="../../../../org/gephi/ranking/api/Ranking.html" title="type parameter in Ranking">Element</a>&nbsp;element)</code>
<div class="block">Returns the value of the element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#normalize(java.lang.Number)">normalize</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;value)</code>
<div class="block">Normalize <code>value</code> between 0 and 1 using the minimum and the
 maximum value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Ranking.html#unNormalize(float)">unNormalize</a></strong>(float&nbsp;normalizedValue)</code>
<div class="block">Unnormalize <code>normalizedValue</code> and returns the original element
 value.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="NODE_ELEMENT">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NODE_ELEMENT</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NODE_ELEMENT</pre>
<div class="block">Element type for nodes. The ranking receives a <code>NodeData</code>
 object.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.gephi.ranking.api.Ranking.NODE_ELEMENT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="EDGE_ELEMENT">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EDGE_ELEMENT</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> EDGE_ELEMENT</pre>
<div class="block">Element type for edges. The ranking receives a <code>EdgeData</code>
 object.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.gephi.ranking.api.Ranking.EDGE_ELEMENT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEGREE_RANKING">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEGREE_RANKING</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEGREE_RANKING</pre>
<div class="block">Default in degree ranking's name</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.gephi.ranking.api.Ranking.DEGREE_RANKING">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="INDEGREE_RANKING">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INDEGREE_RANKING</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> INDEGREE_RANKING</pre>
<div class="block">Default out degree ranking's name</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.gephi.ranking.api.Ranking.INDEGREE_RANKING">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="OUTDEGREE_RANKING">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OUTDEGREE_RANKING</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OUTDEGREE_RANKING</pre>
<div class="block">Default out degree ranking's name</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.gephi.ranking.api.Ranking.OUTDEGREE_RANKING">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getValue(java.lang.Object)">
<!--   -->
</a><a name="getValue(Element)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;getValue(<a href="../../../../org/gephi/ranking/api/Ranking.html" title="type parameter in Ranking">Element</a>&nbsp;element)</pre>
<div class="block">Returns the value of the element.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - the element to get the value from</dd>
<dt><span class="strong">Returns:</span></dt><dd>the element's value</dd></dl>
</li>
</ul>
<a name="getMinimumValue()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinimumValue</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;getMinimumValue()</pre>
<div class="block">Returns the minimum value of this ranking.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the minimum value</dd></dl>
</li>
</ul>
<a name="getMaximumValue()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumValue</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;getMaximumValue()</pre>
<div class="block">Returns the maximum value of this ranking.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the maximum value</dd></dl>
</li>
</ul>
<a name="normalize(java.lang.Number)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>normalize</h4>
<pre>float&nbsp;normalize(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;value)</pre>
<div class="block">Normalize <code>value</code> between 0 and 1 using the minimum and the
 maximum value. For example if <code>value</code> is equal to the maximum,
 it returns 1.0.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value to normalize</dd>
<dt><span class="strong">Returns:</span></dt><dd>the normalized value between zero and one</dd></dl>
</li>
</ul>
<a name="unNormalize(float)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unNormalize</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;unNormalize(float&nbsp;normalizedValue)</pre>
<div class="block">Unnormalize <code>normalizedValue</code> and returns the original element
 value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>normalizedValue</code> - the value to unnormalize</dd>
<dt><span class="strong">Returns:</span></dt><dd>the original value of the element</dd></dl>
</li>
</ul>
<a name="getDisplayName()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDisplayName</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDisplayName()</pre>
<div class="block">Returns the display name of this ranking.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the display name of this ranking</dd></dl>
</li>
</ul>
<a name="getName()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Returns the name of this ranking. It should be unique.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name of this ranking</dd></dl>
</li>
</ul>
<a name="getElementType()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getElementType</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getElementType()</pre>
<div class="block">Return the type of element this ranking is manipulating. Value can either be
 <code>Ranking.NODE_ELEMENT</code> or <code>Ranking.EDGE_ELEMENT</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the type of element this ranking is manipulating</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Ranking.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/ranking/api/Interpolator.BezierInterpolator.html" title="class in org.gephi.ranking.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/ranking/api/RankingController.html" title="interface in org.gephi.ranking.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/ranking/api/Ranking.html" target="_top">Frames</a></li>
<li><a href="Ranking.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
